/**
 * Copyright (c) 2013-2022 Nikita Koksharov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.redisson.client.codec;

import java.util.BitSet;

import org.redisson.client.handler.State;
import org.redisson.client.protocol.Decoder;
import org.redisson.client.protocol.Encoder;

import io.netty.buffer.ByteBuf;
/**
 * BitSetCodec类实现了Codec接口，用于序列化和反序列化BitSet对象。
 * BitSet是一个二进制位的集合，常用于高效地表示大量布尔值。
 */
public class BitSetCodec implements Codec {

    /**
     * 单例实例，提供一种无需构造函数的获取Codec实例的方式。
     */
    public static final BitSetCodec INSTANCE = new BitSetCodec();

    /**
     * 解码器实例，用于从ByteBuf中读取数据并转换为BitSet对象。
     */
    private final Decoder<Object> decoder = new Decoder<Object>() {
        @Override
        public Object decode(ByteBuf buf, State state) {
            /**
             * 从ByteBuf中读取所有可读字节到字节数组。
             * 这里之所以使用reverse方式，是因为在序列化BitSet时，是从低位到高位存储的，
             * 而Java的字节序是高位在前，因此需要反转以保持正确的顺序。
             */
            byte[] result = new byte[buf.readableBytes()];
            buf.readBytes(result);
            return fromByteArrayReverse(result);
        }
    };

    /**
     * 从字节数组反序列化为BitSet对象，字节数组的顺序是高位在前。
     *
     * @param bytes 字节数组，表示序列化的BitSet。
     * @return 反序列化后的BitSet对象。
     */
    private static BitSet fromByteArrayReverse(byte[] bytes) {
        BitSet bits = new BitSet();
        for (int i = 0; i < bytes.length * 8; i++) {
            /**
             * 检查每一位是否为1，如果是，则在BitSet中设置对应位为true。
             * 这里使用了位操作来从字节数组中提取每一位。
             */
            if ((bytes[i / 8] & (1 << (7 - (i % 8)))) != 0) {
                bits.set(i);
            }
        }
        return bits;
    }

    /**
     * 获取用于反序列化值的解码器。
     *
     * @return 解码器实例。
     */
    @Override
    public Decoder<Object> getValueDecoder() {
        return decoder;
    }

    /**
     * 不支持序列化操作，抛出UnsupportedOperationException异常。
     *
     * @return 无返回值，始终抛出异常。
     */
    @Override
    public Encoder getValueEncoder() {
        throw new UnsupportedOperationException();
    }

    /**
     * 不支持反序列化Map值操作，抛出UnsupportedOperationException异常。
     *
     * @return 无返回值，始终抛出异常。
     */
    @Override
    public Decoder<Object> getMapValueDecoder() {
        throw new UnsupportedOperationException();
    }

    /**
     * 不支持序列化Map值操作，抛出UnsupportedOperationException异常。
     *
     * @return 无返回值，始终抛出异常。
     */
    @Override
    public Encoder getMapValueEncoder() {
        throw new UnsupportedOperationException();
    }

    /**
     * 不支持反序列化Map键操作，抛出UnsupportedOperationException异常。
     *
     * @return 无返回值，始终抛出异常。
     */
    @Override
    public Decoder<Object> getMapKeyDecoder() {
        throw new UnsupportedOperationException();
    }

    /**
     * 不支持序列化Map键操作，抛出UnsupportedOperationException异常。
     *
     * @return 无返回值，始终抛出异常。
     */
    @Override
    public Encoder getMapKeyEncoder() {
        throw new UnsupportedOperationException();
    }

    /**
     * 返回当前类的类加载器。
     *
     * @return 类加载器实例。
     */
    @Override
    public ClassLoader getClassLoader() {
        return getClass().getClassLoader();
    }

}

